home *** CD-ROM | disk | FTP | other *** search
/ Reverse Code Engineering RCE CD +sandman 2000 / ReverseCodeEngineeringRceCdsandman2000.iso / RCE / Library / +ORC / Orc pac 2 / FILEZ.ZIP / SR651.ZIP / SRFILES.EXE / TESTYN.REM < prev    next >
Encoding:
Text File  |  1995-05-18  |  5.5 KB  |  123 lines
  1.  
  2.  
  3.                    ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  4.                       SOURCER REMARKS FILE - SAMPLE REMARKS
  5.                    ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
  6.  
  7.  
  8.  ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ DATA REMARKS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  9.  
  10.         Remarks in this section are linked to the .def  file,  section  3
  11.         relating to data items.    Remarks  will  appear  in  the  source
  12.         code output to the right of the data reference  definition.   Each
  13.         remark can encompass as many lines as needed, up to 34 characters
  14.         per line.  Each line starts with the 3 digit hex reference number
  15.         starting at 001 to a maximum of 3FFh (1023 entries).   The number
  16.         is also entered in the .def file for the particular data item(s).
  17.  
  18.  
  19.     --------- Data Remarks -----------  -------- comments ignored here --------
  20. 001 This is the remark number 1
  21. 002 This is another remark
  22. 003 This is the next data remark
  23.      note how it continues onto three
  24.      lines ! (indents allowed)
  25. 004 █▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀█
  26.     █ Lines starting with a graphics █
  27.     █ character will be placed prior █
  28.     █ to the line that the data item █
  29.     █ comment appears on.            █
  30.     █                                █
  31.     █ A line feed will automatically █
  32.     █ be place prior  to  and  after █
  33.     █ the graphics character area.   █
  34.     █▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄█
  35.     this line is left of data item 4
  36. 005 This is the last data comment !
  37. 006 █▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀█          Highlight information prior
  38.     █  Port Values used in Program  █          to a data item with graphics
  39.     █▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄█          characters !
  40.     Port to toggle speaker on & off            (spekaer_port)
  41. 007 Port for timer 0 mode                      (timer_0_port)
  42. end
  43.  
  44.  
  45.  ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ LOCATION REMARKS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  46.  
  47.         Remarks in this section are linked to the .def  file,  section  3
  48.         relating to location references.   Remarks  will  appear  in  the
  49.         source code output as lines prior to  the  location  item.   Each
  50.         remark can encompass as many lines as needed, up to 76 characters
  51.         per line.  Each line starts with the 2 digit hex reference number
  52.         starting at 01 up to a maximum of FEh (254 entries).   The number
  53.         is entered in the .def file for the particular location item(s).
  54.  
  55.         relating to location references.   Remarks  will  appear  in  the
  56.         source code output as lines prior to  the  location  item.   Each
  57.         remark can encompass as many lines as needed, up to 76 characters
  58.         per line.  Each line starts with the 2 digit hex reference number
  59.         starting at 01 up to a maximum of FEh (254 entries).   The number
  60.         is entered in the .def file for the particular location item(s).
  61.  
  62.  
  63.     ----------------------- Location Reference Remarks ------------------------
  64. 01  This is a location reference remark
  65.  
  66. 02  ═════════════════════════════════════════════╡ GRAPHICS ╞═════════════
  67.  
  68.       ■  All graphics characters are allowed for special highlighting
  69.  
  70.       ■  Line feeds can be inserted for extra clarity
  71.  
  72. 03  Text of each remark begins at column 5 in this file
  73.  
  74. 04  ───── TESTYN OPERATION ───────────────────────────────────────────────
  75.  
  76.     Testyn waits for a keystroke "n" or "y", or beeps if any other key has
  77.     been entered.    When "n" or "y" is entered,  the program exits with a
  78.     return code 0 for "n", and 1 for "y".
  79.  
  80.     It is intended to be used in a batch file when a  yes/no  question  is
  81.     asked, the errorlevel command can be used to read the return code.
  82.  
  83. 05
  84.     Line feeds can be placed at the beginning for more separation from  the
  85.         previous section of code (1 line feed is automatically placed
  86.         prior to the remark).  No linefeeds are placed after the remark
  87.         unless explicitly done as in these examples.
  88.  
  89. end
  90.  
  91.  ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ SUBROUTINE REMARKS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  92.  
  93.         Remarks in this section are linked to the .def  file,  section  3
  94.         relating to subroutine references.   Remarks will appear  in  the
  95.         source code output as lines prior to the subroutine  item.   Each
  96.         remark can encompass as many lines as needed, up to 76 characters
  97.         per line.  Each line starts with the 2 digit hex reference number
  98.         starting at 01 up to a maximum of FFh (255 entries).   The number
  99.         is entered in the .def file for a particular subroutine item(s).
  100.  
  101.  
  102.     ---------------------- Subroutine Reference Remarks -----------------------
  103. 01  This is a subroutine reference remark
  104. 02                                 BEEPER
  105.  
  106.         This subroutine generates a beep based on the passed parameters.
  107.         Note that the sound and duration are uP speed independent. Some
  108.         newer AMI BIOSs, which stray from the IBM standard, use the
  109.         wrong timer 0 mode, which causes the beep sound to be twice as
  110.         long (lower pitch).
  111. 02                                 DELAY
  112.  
  113.         The passed parameter specifies the number of timer 0 counts to
  114.         wait.  When timer 0 in mode 3 (the standard mode) each count
  115.         represents 0.4 uS of duration.
  116. end
  117.  
  118.  
  119.         NOTES:  1)  Entries must be in consecutive sequential order.
  120.                 2)  Remark characters ";" are automatically inserted.
  121.                 3)  Up to 64,000 lines per remark, 32M max file size.
  122.  
  123.